package com.itany.cloud.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Author:shixiaojun@itany.com
 * Date: 2022/3/21 14:25
 * Version: 1.0-SNAPSHOT
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestfulApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                // 扫包,扫描Swagger2注解所在的包
                .select()
                // 指定需要扫描的包
                .apis(RequestHandlerSelectors.basePackage("com.itany.cloud.controller"))
                // 级联扫包,当扫描指定的包下的内容时,涉及到其他包下的类
                // 会自动扫描指定的类
                .paths(PathSelectors.any())
                .build();
    }


    public ApiInfo apiInfo(){
        // 可以直接使用ApiInfo对象提供的构造器进行构造
        // 但是直接使用时必须指定该对象中所需要的所有属性
        // 如果我们只需要部分属性
        // 可以通过ApiInfoBuilder对象进行局部构造
        // 最终调用build方法返回ApiInfo对象
        return new ApiInfoBuilder()
                // 标题
                .title("PC端API接口文档")
                // 详细描述
                .description("使用Swagger2生成的PC端的Restful API接口文档")
                // 设置联系人信息
                .contact(new Contact("admin","https://www.baidu.com/","123456789@qq.com"))
                // 设置版本号
                .version("1.0-SNAPSHOT")
                .build();
    }
}
